git-url-parse

What is git-url-parse?

The git-url-parse npm package is a utility for parsing Git URLs and extracting useful information from them. It supports various Git URL formats and provides methods to manipulate and retrieve different parts of the URL.

What are git-url-parse's main functionalities?

Parsing a Git URL

This feature allows you to parse a Git URL and get an object containing various parts of the URL such as the protocol, source, owner, name, and more.

const gitUrlParse = require('git-url-parse');
const parsed = gitUrlParse('https://github.com/IonicaBizau/git-url-parse.git');
console.log(parsed);

Extracting the owner and name

This feature allows you to extract specific parts of the Git URL, such as the owner and repository name.

const gitUrlParse = require('git-url-parse');
const parsed = gitUrlParse('https://github.com/IonicaBizau/git-url-parse.git');
console.log(parsed.owner); // 'IonicaBizau'
console.log(parsed.name); // 'git-url-parse'

Converting to a different URL format

This feature allows you to convert a Git URL from one format to another, such as from HTTPS to SSH.

const gitUrlParse = require('git-url-parse');
const parsed = gitUrlParse('https://github.com/IonicaBizau/git-url-parse.git');
const sshUrl = parsed.toString('ssh');
console.log(sshUrl); // '[e-mail]:IonicaBizau/git-url-parse.git'

Other packages similar to git-url-parse

parse-github-url

The parse-github-url package is a utility for parsing GitHub URLs specifically. It extracts information such as the owner, repository name, and branch. Compared to git-url-parse, it is more focused on GitHub URLs and may not support other Git hosting services.

git-url

The git-url package provides similar functionality for parsing and manipulating Git URLs. It offers methods to extract parts of the URL and convert between different URL formats. It is comparable to git-url-parse in terms of functionality but may have different API design and usage patterns.

url-parse

The url-parse package is a more general-purpose URL parsing library that can handle various types of URLs, not just Git URLs. While it can be used to parse Git URLs, it does not provide Git-specific methods and properties like git-url-parse does.

README

git-url-parse

A high level git url parser for common git providers.

:cloud: Installation

# Using npm
npm install --save git-url-parse

# Using yarn
yarn add git-url-parse

:clipboard: Example

// Dependencies
const GitUrlParse = require("git-url-parse");

console.log(GitUrlParse("[e-mail]:IonicaBizau/node-git-url-parse.git"));
// => {
//     protocols: []
//   , port: null
//   , resource: "github.com"
//   , user: "git"
//   , pathname: "/IonicaBizau/node-git-url-parse.git"
//   , hash: ""
//   , search: ""
//   , href: "[e-mail]:IonicaBizau/node-git-url-parse.git"
//   , token: ""
//   , protocol: "ssh"
//   , toString: [Function]
//   , source: "github.com"
//   , name: "node-git-url-parse"
//   , owner: "IonicaBizau"
// }

console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git"));
// => {
//     protocols: ["https"]
//   , port: null
//   , resource: "github.com"
//   , user: ""
//   , pathname: "/IonicaBizau/node-git-url-parse.git"
//   , hash: ""
//   , search: ""
//   , href: "https://github.com/IonicaBizau/node-git-url-parse.git"
//   , token: ""
//   , protocol: "https"
//   , toString: [Function]
//   , source: "github.com"
//   , name: "node-git-url-parse"
//   , owner: "IonicaBizau"
// }

console.log(GitUrlParse("https://github.com/IonicaBizau/git-url-parse/blob/master/test/index.js"));
// { protocols: [ 'https' ],
//   protocol: 'https',
//   port: null,
//   resource: 'github.com',
//   user: '',
//   pathname: '/IonicaBizau/git-url-parse/blob/master/test/index.js',
//   hash: '',
//   search: '',
//   href: 'https://github.com/IonicaBizau/git-url-parse/blob/master/test/index.js',
//   token: '',
//   toString: [Function],
//   source: 'github.com',
//   name: 'git-url-parse',
//   owner: 'IonicaBizau',
//   organization: '',
//   ref: 'master',
//   filepathtype: 'blob',
//   filepath: 'test/index.js',
//   full_name: 'IonicaBizau/git-url-parse' }

console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git").toString("ssh"));
// => "[e-mail]:IonicaBizau/node-git-url-parse.git"

console.log(GitUrlParse("[e-mail]:IonicaBizau/node-git-url-parse.git").toString("https"));
// => "https://github.com/IonicaBizau/node-git-url-parse.git"

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

gitUrlParse(url)

Parses a Git url.

Params

• String url: The Git url to parse.

Return

• GitUrl The GitUrl object containing:
• protocols (Array): An array with the url protocols (usually it has one element).
• port (null|Number): The domain port.
• resource (String): The url domain (including subdomains).
• user (String): The authentication user (usually for ssh urls).
• pathname (String): The url pathname.
• hash (String): The url hash.
• search (String): The url querystring value.
• href (String): The input url.
• protocol (String): The git url protocol.
• token (String): The oauth token (could appear in the https urls).
• source (String): The Git provider (e.g. "github.com").
• owner (String): The repository owner.
• name (String): The repository name.
• ref (String): The repository ref (e.g., "master" or "dev").
• filepath (String): A filepath relative to the repository root.
• filepathtype (String): The type of filepath in the url ("blob" or "tree").
• full_name (String): The owner and name values in the owner/name format.
• toString (Function): A function to stringify the parsed url into another url type.
• organization (String): The organization the owner belongs to. This is CloudForge specific.
• git_suffix (Boolean): Whether to add the .git suffix or not.

stringify(obj, type)

Stringifies a GitUrl object.

Params

• GitUrl obj: The parsed Git url object.
• String type: The type of the stringified url (default obj.protocol).

Return

• String The stringified url.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• autorelease-setup (by Tyler Johnson)—A CLI tool for setting up a repository with autorelease.
• belt-repo (by ewnd9)—repo module for belt
• bibi (by steelbrain)—A repository management tool
• branch-release (by Roman Hotsiy)—Build and tag package realease on a separate branch
• changelog.md (by EGOIST)—Manage CHANGELOG.md so easy it hurts.
• ci-yarn-upgrade (by taichi)—Keep NPM dependencies up-to-date with CI, providing version-to-version diff for each library
• clipped (by IniZio)—Reduce pain of configuration to once
• committing (by Axetroy)—commit every days
• complan (by Pranav Parikh)—COMPLexity ANalyzer Tool For Javascript
• def-core (by tbfed)—def core for deflite
• docula-ui—Express.js bindings for Docula project
• docula-ui-express—Express.js bindings for Docula project
• documentation (by Tom MacWright)—a documentation generator
• documentation-fork (by Tom MacWright)—a documentation generator
• documentation-habitlab (by Tom MacWright)—a documentation generator
• download-repo-cli (by EGOIST)—CLI tool to download GitHub repo.
• gd-cli (by Sylvain Baronnet)—GD Command Line Interface
• generator-ckeditor4 (by Marek Lewandowski)—Yeoman generator for CKEditor 4
• generator-clearphp (by Joschi Kuphal)—Scaffold for Composer based PHP projects with a lot of integrations, advocating the use of The Clear Architecture (https://jkphl.is/articles/clear-architecture-php)
• generator-nm-bti (by Tyler Johnson)—Scaffold out a node module, Beneath the Ink style.
• generator-openapi-repo (by Roman Hotsiy)—Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API
• git-cherry-fix—> helps you get your fixes to another branch by cherry-picking them
• git-issues (by Gabriel Petrovay)—Git issues extension to list issues of a Git project
• git-lab-cli—gitlab-cli ==================
• git-signed (by Marc Trudel)—git commit signing made easy (and enforceable)
• git-source—Parse and stringify git urls in a friendly way.
• git-url-promise (by Evgeniy Shershnev)—Git url promise
• gitbook-start-https-alex-moi (by Moises Yanes Carballo)—Plugin deploy iaas https
• gitbook-start-iaas-bbdd-alex-moi (by Moises Yanes Carballo)—Plugin deploy iaas bbdd
• gitbook-start-iaas-ull-es-alex-moi (by Moises Yanes Carballo)—Plugin deploy maquina iaas-ull-es
• gitbook-start-iaas-ull-es-merquililycony (by Constanza León, Merquis Cruz, Liliana Galiano)—El objetivo de esta práctica es extender el package NodeJS publicado en npm en una práctica anterior con una nueva funcionalidad que permita que los usuarios realizar un despliegue automatico en el servidor de IAAS
• gitbook-start-plugin-iaas-ull-es-noejaco2017 (by alu0100622492)—Despliegue plugin Iaas
• gitc (by Cezar Luiz)—Manage your pull requests and issues from your command line.
• github-publish-npm (by Ofer Sadgat)—This will upload publish npm assets to the GitHub Releases API.
• gitlab-ci-variables-cli (by Khoa Tran)—CLI tool to set/get pipeline variables on Gitlab CI.
• gitline (by Cezar Luiz)—Manage your pull requests and issues from your command line.
• gtni (by Nur Mohammed Rony)—Install your all npm dependencies recursively with gtni while you are doing git clone, fetch or pull
• kef-core (by younth)—The awesome KEF
• lcov-server (by Gabriel J. Csapo)—🎯 A simple lcov server & cli parser
• moto-connector (by limingv5)—FEB平台SDK
• nodeschool-admin (by Martin Heidegger)—CLI tool for setting up and maintaining a nodeschool chapters and other things.
• ogh (by EGOIST)—Open GitHub Page of your repo directly in Terminal.
• one-more-gitlab-cli (by Christophe Hamerling)—One more Gitlab CLI
• pr-log (by Mathias Schreck)—Changelog generator based on GitHub Pull Requests
• proyecto-sytw-alex-moi (by Moises Yanes Carballo)—Module to build a book on GitBook
• semantic-release (by Stephan Bönnemann)—Automated semver compliant package publishing
• ship-release—Publish new versions on GitHub and npm with ease.
• sinit (by villadora)—Project initializer based on Scaffold
• smart-clone—Clone a directory into a Golang style directory structure
• ssh-remote—Automagically switch on the SSH remote url in a Git repository.
• strapper (by Sam Newman)—Coming Soon

:scroll: License

MIT © Ionică Bizău